package runnerworm.ui;

import java.util.*;
import java.awt.*;

/**
 * <p>Title: UserInterfaceEvent</p>
 * <p>Description: This will be the event that represents a user's choice
 * on the UI</p>
 * @author Guilherme Mauro Germoglio Barbosa
 */
public class UserInterfaceEvent
    extends AWTEvent {

  /**
   * This will be the id for the NewGameEvent.
   */
  public static final int NEW_GAME = AWTEvent.RESERVED_ID_MAX + 9000;
  /**
   * This will be the id for the QuitGameEvent.
   */
  public static final int QUIT_GAME = AWTEvent.RESERVED_ID_MAX + 9001;
  /**
   * This will be the id for the OptionsEvent.
   */
  public static final int OPTIONS = AWTEvent.RESERVED_ID_MAX + 9002;
  /**
   * This will be the id for the HighScoresEvent.
   */
  public static final int HIGH_SCORES = AWTEvent.RESERVED_ID_MAX + 9003;
  /**
   * This will be the id for the HelpEvent.
   */
  public static final int HELP = AWTEvent.RESERVED_ID_MAX + 9004;
  /**
   * This will be the id for the AboutEvent.
   */
  public static final int ABOUT = AWTEvent.RESERVED_ID_MAX + 9005;
  /**
   * This will be the id for the WormGoingUpEvent.
   */
  public static final int WORM_GOING_UP = AWTEvent.RESERVED_ID_MAX + 9006;
  /**
   * This will be the id for the WormGoingDownEvent.
   */
  public static final int WORM_GOING_DOWN = AWTEvent.RESERVED_ID_MAX + 9007;
  /**
   * The id for the PlayerNameEvent.
   */
  public static final int PLAYER_NAME = AWTEvent.RESERVED_ID_MAX + 9008;



  /**
   * The constructor. Will receive the event's source and its id.
   * @param userInterfaceEventLauncher The event's source.
   * @param id The event's identification.
   */
  public UserInterfaceEvent(UserInterfaceEventLauncher userInterfaceEventLauncher, int id) {
    super(userInterfaceEventLauncher, id);
  }
}
